Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about default callback implementation #572

Merged
merged 22 commits into from
Jul 3, 2023

Conversation

@Rados13 Rados13 requested a review from FelonEkonom June 29, 2023 13:58
@Rados13 Rados13 self-assigned this Jun 29, 2023
@Rados13 Rados13 requested a review from mat-hek as a code owner June 29, 2023 13:58
@FelonEkonom FelonEkonom added the no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md label Jun 29, 2023
lib/membrane/element/base.ex Outdated Show resolved Hide resolved
lib/membrane/pipeline.ex Outdated Show resolved Hide resolved
lib/membrane/pipeline.ex Outdated Show resolved Hide resolved
@Rados13 Rados13 requested a review from FelonEkonom June 30, 2023 07:20
@FelonEkonom FelonEkonom removed their request for review June 30, 2023 12:44
@Rados13 Rados13 force-pushed the MSB-63/improve-callback-description branch from ef1dab0 to 6c559a6 Compare June 30, 2023 12:53
@FelonEkonom FelonEkonom self-requested a review June 30, 2023 12:58
lib/membrane/bin.ex Outdated Show resolved Hide resolved
lib/membrane/bin.ex Outdated Show resolved Hide resolved
lib/membrane/bin.ex Show resolved Hide resolved
lib/membrane/element/base.ex Outdated Show resolved Hide resolved
lib/membrane/element/base.ex Outdated Show resolved Hide resolved
lib/membrane/pipeline.ex Outdated Show resolved Hide resolved
lib/membrane/pipeline.ex Show resolved Hide resolved
lib/membrane/pipeline.ex Outdated Show resolved Hide resolved
@@ -42,6 +42,7 @@ defmodule Membrane.Bin do
For these reasons, it's important to do any long-lasting or complex work in `c:handle_setup/2`,
while `handle_init` should be used for things like parsing options, initializing state or
spawning children.
By default, it creates a map from opts struct.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default, it converts the opts struct to a map and sets them as the bin's state.

lib/membrane/element/base.ex Outdated Show resolved Hide resolved
@Rados13 Rados13 requested a review from mat-hek June 30, 2023 14:00
lib/membrane/bin.ex Outdated Show resolved Hide resolved
Rados13 and others added 17 commits July 3, 2023 07:56
Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>
Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>
Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Rados13 and others added 5 commits July 3, 2023 07:56
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
@Rados13 Rados13 force-pushed the MSB-63/improve-callback-description branch from 273bb1d to a967dc0 Compare July 3, 2023 05:56
@Rados13 Rados13 merged commit b1cd21f into master Jul 3, 2023
@Rados13 Rados13 deleted the MSB-63/improve-callback-description branch July 3, 2023 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants